⚠️ No Changeset found

Latest commit: baef6fa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Walkthrough

This pull request adds documentation and site entries for a new Smart Spreadsheet example project. Changes include a new MDX page at docs/guides/example-projects/smart-spreadsheet.mdx describing the project, an added card entry in docs/guides/ai-agents/overview.mdx, a new manifest entry in docs/docs.json, and two added references in docs/guides/introduction.mdx. All edits are additive documentation content; no functional code or existing content was modified.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

PR Review: Add Smart Spreadsheet docs

This PR adds documentation for the Smart Spreadsheet example project. Overall, the documentation is well-written and follows the existing patterns in the codebase.

Positive aspects

• Consistent structure: The new smart-spreadsheet.mdx follows the same format as other example project docs (overview, video, GitHub card, how it works, features, relevant code table, and the realtime snippet)
• Good integration: Properly added to docs.json, introduction.mdx, and ai-agents/overview.mdx in alphabetically sorted positions
• Clear descriptions: The workflow explanation and feature descriptions are helpful for users understanding what the example demonstrates
• Appropriate categorization: Listed under AI agents (uses Claude) and as a Next.js example project

Minor suggestions

1. Video source format: The video source URL (https://content.trigger.dev/smart-spreadsheet.mp4) differs from other docs that use GitHub user attachments (e.g., vercel-ai-sdk-deep-research.mdx). This is fine as long as the URL is stable and accessible.

2. Missing get-funding-round.ts file: The table references get-funding-round.ts but the example repo should be verified to ensure this file exists at that path.

3. Consider adding more detail: Other similar docs like vercel-ai-sdk-deep-research.mdx include:

   • Code snippets showing key patterns (e.g., how Realtime is used)
   • More detailed technical explanation of the workflow

   This could help users understand the implementation before visiting the repo, but this is optional.

Verification checklist

• Verify the video URL (https://content.trigger.dev/smart-spreadsheet.mp4) is accessible
• Confirm the example repo exists at https://github.com/triggerdotdev/examples/tree/main/smart-spreadsheet
• Verify all linked source files exist in the repo (enrich-company.ts, get-basic-info.ts, get-industry.ts, get-employee-count.ts, get-funding-round.ts)

Summary

Approve - This is a documentation-only PR that adds a well-structured example project guide. The content is consistent with other example project docs and properly integrated into the navigation structure. The minor suggestions above are optional improvements.

PR Review: Add smart spreadsheet docs

Overall Assessment

This is a clean, well-written documentation addition for the Smart Spreadsheet example project. The PR adds 101 lines across 4 files with no deletions, following the existing documentation patterns well.

What's Good

1. Consistent structure: The new smart-spreadsheet.mdx follows the same format as other example project docs (like vercel-ai-sdk-deep-research.mdx and realtime-csv-importer.mdx) - frontmatter, overview, video, GitHub card, how it works, features, key code patterns, and relevant code table.

2. Correct placement in navigation: The entry in docs.json is alphabetically sorted correctly (between realtime-fal-ai and turborepo-monorepo-prisma).

3. Good cross-linking: Properly links to related Trigger.dev documentation like /realtime/overview, /triggering#batch-trigger-by-task-and-wait, and includes the RealtimeLearnMore snippet.

4. Clear code examples: The code snippets demonstrate the key patterns (parallel task execution with batch.triggerByTaskAndWait and parent metadata updates with metadata.parent.set()).

5. Comprehensive relevant code table: Links to all the key task files in the examples repo.

Minor Suggestions

1. Card icon casing: In the GitHub repo Card component, the icon is "GitHub" but other docs use lowercase "github" (e.g., in some Card components). However, I see both patterns exist in the codebase, so this may be fine - just flagging for consistency consideration.

2. Video URL: The video URL points to https://content.trigger.dev/smart-spreadsheet.mp4 - just ensure this asset is deployed before merging.

No Issues Found

• No code quality concerns (this is documentation only)
• No potential bugs
• No performance or security concerns
• Test coverage N/A for documentation

Verdict

Approve - This is a straightforward documentation addition that follows existing patterns well and adds value by documenting a new example project. Ready to merge once the video asset is confirmed to be available.

PR Review: Add smart spreadsheet docs

Thanks for adding this documentation! The Smart Spreadsheet example is a nice addition to the AI agents documentation. Here's my review:

Overall Assessment

The documentation is well-written and follows the established patterns from other example project docs. The structure is clear and the code examples are helpful.

Suggestions

1. Minor icon casing inconsistency

In docs/guides/example-projects/smart-spreadsheet.mdx, the GitHub icon uses lowercase:

icon="github"

Other docs (like realtime-csv-importer.mdx and vercel-ai-sdk-deep-research.mdx) use:

icon="GitHub"

Consider updating for consistency, though this may be a non-issue depending on how the icon library handles casing.

2. Video section placement

The new doc places the Video section before the GitHub repo card:

## Overview
## Video
## GitHub repo

Some existing docs (like realtime-csv-importer.mdx) place GitHub repo before Video:

## Overview
## GitHub repo
## Video

The deep research doc also has video before GitHub, so this isn't necessarily wrong - just noting the inconsistency across docs. The current placement is fine.

3. Realtime link style

The doc uses:

[Realtime](/realtime/overview)

The deep research doc links to a different page in some places:

[Trigger.dev Realtime](https://trigger.dev/launchweek/0/realtime)

The /realtime/overview internal link is actually better since it points to the current docs rather than a launch week page.

What looks good

• Clear overview explaining what the project does
• Good breakdown of the workflow (5 steps)
• Excellent code examples showing batch.triggerByTaskAndWait and metadata.parent.set()
• Well-organized "Relevant code" table with links to source files
• Proper use of the RealtimeLearnMore snippet
• Alphabetically correct placement in docs.json
• Good addition to the AI agents overview page

Verdict

Approve - This is solid documentation that follows existing patterns. The suggestions above are minor consistency items that could be addressed in a follow-up if desired, but none are blockers.

PR Review: Add smart spreadsheet docs

Summary

This PR adds documentation for a new "Smart Spreadsheet" example project that demonstrates AI-powered company data enrichment using Exa search and Claude with real-time streaming.

Overall Assessment

LGTM - This is a well-structured documentation addition that follows the established patterns in the codebase.

What's Good

1. Consistent structure: The new doc follows the same pattern as other example project docs (e.g., realtime-csv-importer.mdx, vercel-ai-sdk-deep-research.mdx) with Overview, Video, GitHub repo, How it works, Features, Key code patterns, and Relevant code sections.

2. Proper alphabetical ordering: The entry in docs.json is correctly placed alphabetically between realtime-fal-ai and turborepo-monorepo-prisma.

3. Good use of snippets: Correctly imports RealtimeLearnMore snippet for consistent cross-referencing.

4. Clear and useful code examples: The key code patterns section shows practical usage of batch.triggerByTaskAndWait and metadata.parent.set().

5. Appropriate cross-linking: Added to both the AI agents overview page and the introduction guides page.

Minor Suggestions (Non-blocking)

1. GitHub icon casing: In other docs like realtime-csv-importer.mdx (line 20), the icon is "GitHub" (capitalized), but in this PR it's "github" (lowercase). Both might work, but for consistency you may want to use "GitHub":

   -  icon="github"
   +  icon="GitHub"

2. Video section ordering: Most other example docs have the GitHub repo card before the Video section (see vercel-ai-sdk-deep-research.mdx), but this doc has Video before GitHub repo. This is a very minor inconsistency - not a blocker, just something to consider for consistency.

3. Verify example repo exists: Please ensure the smart-spreadsheet example is already merged to the examples repo before merging this docs PR, so all links work immediately.

Checklist

• Follows existing documentation patterns
• Alphabetically ordered in docs.json
• Added to relevant overview pages
• Code examples are correct and useful
• Uses appropriate snippets

Approved pending confirmation that the example repo exists at the linked location.

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.